home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_hylafax.idb / usr / freeware / man / cat1 / faxaddmodem.Z / faxaddmodem
Encoding:
Text File  |  1999-07-16  |  9.3 KB  |  197 lines
  1.  
  2.  
  3.  
  4. FFFFAAAAXXXXAAAADDDDDDDDMMMMOOOODDDDEEEEMMMM((((1111MMMM))))   UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((MMMMaaaayyyy 11112222,,,, 1111999999996666))))    FFFFAAAAXXXXAAAADDDDDDDDMMMMOOOODDDDEEEEMMMM((((1111MMMM))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      faxaddmodem - configure a modem for use with _H_y_l_a_F_A_X
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ////uuuussssrrrr////ffffrrrreeeeeeeewwwwaaaarrrreeee////ssssbbbbiiiinnnn////ffffaaaaxxxxaaaaddddddddmmmmooooddddeeeemmmm [ ----ssss _s_p_e_e_d ] [ _t_t_y ]
  13.  
  14. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.      _f_a_x_a_d_d_m_o_d_e_m is an interactive shell script that does the
  16.      necessary setup work to configure a modem for use by the
  17.      _H_y_l_a_F_A_X software.  To enable use of the configured modem one
  18.      must either use the _f_a_x_m_o_d_e_m(1M) program or configure the
  19.      _i_n_i_t(1M) program to startup a _f_a_x_g_e_t_t_y(1M) process for the
  20.      newly configured modem.  In either case the _f_a_x_q(1M) program
  21.      must also be running if outbound services are to be
  22.      provided.
  23.  
  24.      If the serial port name is not specified on the command line
  25.      _f_a_x_a_d_d_m_o_d_e_m will prompt for it.
  26.  
  27.      The configuration work done by _f_a_x_a_d_d_m_o_d_e_m falls into two
  28.      main areas: creating the necessary files to run a facsimile
  29.      server process, and defining the contents of the
  30.      configuration database file.  The _c_o_n_f_i_g (_4_F) manual page
  31.      has an in-depth description of the contents of the
  32.      configuration file and should be consulted when installing a
  33.      modem.
  34.  
  35.      Many aspects of configuring a modem are operating system-
  36.      specific; _f_a_x_a_d_d_m_o_d_e_m uses a collection of support routines
  37.      and parameters that are generated by the _f_a_x_s_e_t_u_p(1M)
  38.      program.  If _f_a_x_s_e_t_u_p has not been run on a machine prior to
  39.      running then _f_a_x_a_d_d_m_o_d_e_m will abort.
  40.  
  41.      _f_a_x_a_d_d_m_o_d_e_m can be used to install a new modem or re-
  42.      configure an existing modem.  In the latter case it will
  43.      propagate all the server-related configuration parameters
  44.      from the existing configuration file to the new
  45.      configuration file.  These parameter include items such as
  46.      the phone number, area code, and tracing control parameters.
  47.      Modem-related configuration parameters are, however, not
  48.      propagated.  Instead _f_a_x_a_d_d_m_o_d_e_m deduces the type of modem
  49.      attached to the specified serial port and then sets up the
  50.      configuration parameters using a set of _p_r_o_t_o_t_y_p_e
  51.      configuration files that have been tested with like modems.
  52.      If a modem is to be installed for which there is no existing
  53.      prototype file, _f_a_x_a_d_d_m_o_d_e_m will work from a comprehensive
  54.      template of parameters that can be edited either during or
  55.      after the installation process.
  56.  
  57.      _f_a_x_a_d_d_m_o_d_e_m deduces the type of modem attached to the serial
  58.      port by sending commands to the modem at a fixed speed.  By
  59.      default, this speed is deduced by sending commands to the
  60.  
  61.  
  62.  
  63. Page 1                                          (printed 6/24/99)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. FFFFAAAAXXXXAAAADDDDDDDDMMMMOOOODDDDEEEEMMMM((((1111MMMM))))   UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((MMMMaaaayyyy 11112222,,,, 1111999999996666))))    FFFFAAAAXXXXAAAADDDDDDDDMMMMOOOODDDDEEEEMMMM((((1111MMMM))))
  71.  
  72.  
  73.  
  74.      modem at successively decreasing speeds until a valid
  75.      response is received.  Alternatively, a fixed speed can be
  76.      specified from the command line with the ----ssss option.
  77.  
  78.      Because _f_a_x_a_d_d_m_o_d_e_m needs to read and write the modem that
  79.      is to be installed it will not proceed with an installation
  80.      if the modem is locked for use by another process.
  81.  
  82.      Finally, note that an installation can be safely aborted at
  83.      any time by hitting the interrupt key.  _f_a_x_a_d_d_m_o_d_e_m delays
  84.      making installation-related changes until after everything
  85.      has been setup.
  86.  
  87. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  88.      ----ssss _s_p_e_e_d  Communicate with the modem at a fixed _s_p_e_e_d; this
  89.                may be any value recognized by the _s_t_t_y(1)
  90.                command.
  91.  
  92. PPPPRRRROOOOTTTTOOOOTTTTYYYYPPPPEEEE CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN FFFFIIIILLLLEEEESSSS
  93.      _f_a_x_a_d_d_m_o_d_e_m uses prototype configuration files that have
  94.      been created for known modems.  These prototype files are
  95.      kept in the ccccoooonnnnffffiiiigggg subdirectory and, by convention, have
  96.      names that identify a brand or type of modem and the DTE-DCE
  97.      flow control scheme the prototype files configures.  The
  98.      _f_a_x_a_d_d_m_o_d_e_m(1M) program that is used to configure a modem
  99.      for use with _H_y_l_a_F_A_X selects a prototype configuration file
  100.      using information retrieved from the modem and comments
  101.      embedded in the prototype files.  For Class 1 modems the
  102.      product ID code returned by the command ``ATI0'' and the
  103.      response from the comannd ``ATI3'' are used to select a
  104.      prototype configuration file, while for Class 2 modems the
  105.      manufacturer and model as returned by ``AT+FMFR?'' and
  106.      ``AT+FMDL?'', respectively, are used (or ``AT+FMI?'' and
  107.      ``AT+FMM?'' for Class 2.0 modems).
  108.  
  109.      A Class 1 prototype configuration file is identified for use
  110.      by _f_a_x_a_d_d_m_o_d_e_m by searching for a comment of the form:
  111.      # CONFIG:CLASS1:144:.*:RTSCTS: Manufacturer='AT&T' Model=Dataport
  112.      In this example ``144'' is the product ID code for an AT&T
  113.      DataPort modem, ``.*'' is a regular expression matched
  114.      against the result string returned by the ``ATI3'' command,
  115.      and ``RTSCTS'' indicates the modem is configured to use
  116.      hardware flow control during fax operation.  The remainder
  117.      of the line is evaluated by the _s_h(1) and used to specify
  118.      the modem's manufacturer and model (since Class 1 modems do
  119.      not have standard commands to query this information).
  120.  
  121.      Class 2 and 2.0 prototype configuration files match the
  122.      string ``_m_a_n_u_f_a_c_t_u_r_e_r-_m_o_d_e_l-_f_l_o_w_c_o_n_t_r_o_l'' against a _s_h(1)
  123.      glob pattern specified in the configuration file, where
  124.      _m_a_n_u_f_a_c_t_u_r_e_r and _m_o_d_e_l are the strings returned by querying
  125.  
  126.  
  127.  
  128. Page 2                                          (printed 6/24/99)
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135. FFFFAAAAXXXXAAAADDDDDDDDMMMMOOOODDDDEEEEMMMM((((1111MMMM))))   UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((MMMMaaaayyyy 11112222,,,, 1111999999996666))))    FFFFAAAAXXXXAAAADDDDDDDDMMMMOOOODDDDEEEEMMMM((((1111MMMM))))
  136.  
  137.  
  138.  
  139.      the modem and _f_l_o_w_c_o_n_t_r_o_l is either ``RTSCTS'' for hardware
  140.      flow control or ``XONXOFF'' for software flow control.  For
  141.      example:
  142.      # CONFIG: CLASS2: ZyXEL*-RTSCTS
  143.      # CONFIG: CLASS2.0: USRobotics*-XONXOFF
  144.      are configuration comments that appear in the prototype file
  145.      for a ZyXEL 1496E with Class 2 support, and for a US
  146.      Robotics Courier modem with Class 2.0 firmware.
  147.  
  148.      The _f_a_x_a_d_d_m_o_d_e_m program merges server-specific configuration
  149.      parameters into a prototype configuration according to
  150.      comments placed in the prototype file.  All lines between
  151.      ``BEGIN-SERVER'' and ``END-SERVER'' comments are placed with
  152.      the appropriate server configuration parameters.  Note that
  153.      this means modem-related configuration parameters must be
  154.      placed outside this area of the file.
  155.  
  156. FFFFIIIILLLLEEEESSSS
  157.      /usr/freeware/var/spool/fax/etc/setup.cache    master configuration parameters
  158.      /usr/freeware/var/spool/fax/etc/setup.modem    modem-related configuration support
  159.      /usr/freeware/var/spool/fax/config             prototype configuration files
  160.      /usr/freeware/sbin/ondelay                     program to open device without waiting for carrier
  161.      /usr/freeware/sbin/lockname                    SVR4 UUCP lockfile name generator
  162.  
  163.      Consult _h_y_l_a_f_a_x(4F) for a complete discussion of the
  164.      structure and content of the spooling area.
  165.  
  166. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  167.      _h_y_l_a_f_a_x(4F), _c_o_n_f_i_g(4F), _f_a_x_s_e_t_u_p(1M), _f_a_x_q(1M),
  168.      _f_a_x_g_e_t_t_y(1M), _f_a_x_m_o_d_e_m(1M), _f_a_x_c_o_n_f_i_g(1M), _f_a_x_s_e_n_d(1M)
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193. Page 3                                          (printed 6/24/99)
  194.  
  195.  
  196.  
  197.